Update README with module usage guide#13
Merged
Conversation
Added a detailed guide explaining when to use each module, including a table of modules, usage scenarios, and import instructions. Clarified the difference between quick start and advanced usage, and updated the module structure section for better clarity.
There was a problem hiding this comment.
Pull request overview
This PR enhances the README by adding a comprehensive module usage guide to help users choose the appropriate module for their needs. The changes transform the previous simple "Module Structure" section into a more detailed "Module Guide" with clear usage scenarios and import instructions.
Key Changes:
- Added a decision-making table comparing all four modules (str, str/core, str/extra, str/tokenize) with usage scenarios
- Provided clear guidance distinguishing quick start usage from advanced usage patterns
- Expanded the module structure diagram to show actual file names and better distinguish internal vs public APIs
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | **`str`** | Most common operations | `import str` | | ||
| | **`str/core`** | Full grapheme-aware API, advanced features | `import str/core` | | ||
| | **`str/extra`** | ASCII folding, slugs, case conversions | `import str/extra` | | ||
| | **`str/tokenize`** | Reference implementation (pedagogic only) | `import str/tokenize` | |
There was a problem hiding this comment.
The term "pedagogic" should be "pedagogical" for proper grammar. "Pedagogical" is the standard adjective form when describing something educational or instructional in nature.
Suggested change
| | **`str/tokenize`** | Reference implementation (pedagogic only) | `import str/tokenize` | | |
| | **`str/tokenize`** | Reference implementation (pedagogical only) | `import str/tokenize` | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added a detailed guide explaining when to use each module, including a table of modules, usage scenarios, and import instructions. Clarified the difference between quick start and advanced usage, and updated the module structure section for better clarity.